-
Notifications
You must be signed in to change notification settings - Fork 33
Error context #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crbelaus
commented
Jun 12, 2024
odarriba
reviewed
Jun 12, 2024
Contributor
odarriba
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added some comments. It is mostly ready, the only part I don't know is getting the right context on Phoenix/Plug errors due to when the context is populated.
odarriba
approved these changes
Jun 14, 2024
odarriba
approved these changes
Jun 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request allows us to set relevant context for the current process and also includes a plug that builds up the context for the current request.
The new
ErrorTracker.put_context/1function uses the process dictionary to store the given context. The context is additive which means that we can callErrorTracker.put_context/1multiple times and each call will append to the previous context. If we set twice the same key, the last value will override the previous ones.There is also a new
ErrorTracker.Integrations.Plug.RequestContext(which may need a better name) that automatically populates the context with relevant data for the current request such as: method, path, query string, headers, etc.The Oban integration has been updated to set the context when the job starts instead of only during a captured exception.
I made the choice of using dots to namespace the context keys. For example we have
"request.host"and"request.method"instead of"request" => %{"host" => "", "method" => ""}.I think that having plain keys by default makes them easier to override by clients if they want to. To override an existing key or add a new one to an existing namespace you just add that key and call it a day. If we used the nested map approach you would need to handle deeply nested keys which makes it more difficult.
In the UI we can use the dot as namespace separator and group the keys as we please. I am still not 100% sure about this so I am open to suggestions.